<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>generic::basic_endpoint</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="experimental__this_coro__token_t.html" title="experimental::this_coro::token_t">
<link rel="next" href="generic__basic_endpoint/basic_endpoint.html" title="generic::basic_endpoint::basic_endpoint">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="experimental__this_coro__token_t.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="generic__basic_endpoint/basic_endpoint.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.generic__basic_endpoint"></a><a class="link" href="generic__basic_endpoint.html" title="generic::basic_endpoint">generic::basic_endpoint</a>
</h3></div></div></div>
<p>
        Describes an endpoint for any socket type.
      </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>&gt;
class basic_endpoint
</pre>
<h5>
<a name="asio.reference.generic__basic_endpoint.h0"></a>
        <span><a name="asio.reference.generic__basic_endpoint.types"></a></span><a class="link" href="generic__basic_endpoint.html#asio.reference.generic__basic_endpoint.types">Types</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/data_type.html" title="generic::basic_endpoint::data_type"><span class="bold"><strong>data_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The type of the endpoint structure. This type is dependent on the
                  underlying implementation of the socket layer.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/protocol_type.html" title="generic::basic_endpoint::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The protocol type associated with the endpoint.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.generic__basic_endpoint.h1"></a>
        <span><a name="asio.reference.generic__basic_endpoint.member_functions"></a></span><a class="link" href="generic__basic_endpoint.html#asio.reference.generic__basic_endpoint.member_functions">Member
        Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/basic_endpoint.html" title="generic::basic_endpoint::basic_endpoint"><span class="bold"><strong>basic_endpoint</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Default constructor. <br> <span class="silver"> &#8212;</span><br> Construct an endpoint from the
                  specified socket address. <br> <span class="silver"> &#8212;</span><br> Construct an endpoint from
                  the specific endpoint type. <br> <span class="silver"> &#8212;</span><br> Copy constructor.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/capacity.html" title="generic::basic_endpoint::capacity"><span class="bold"><strong>capacity</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the capacity of the endpoint in the native type.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/data.html" title="generic::basic_endpoint::data"><span class="bold"><strong>data</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the underlying endpoint in the native type.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/operator_eq_.html" title="generic::basic_endpoint::operator="><span class="bold"><strong>operator=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Assign from another endpoint.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/protocol.html" title="generic::basic_endpoint::protocol"><span class="bold"><strong>protocol</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The protocol associated with the endpoint.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/resize.html" title="generic::basic_endpoint::resize"><span class="bold"><strong>resize</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Set the underlying size of the endpoint in the native type.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/size.html" title="generic::basic_endpoint::size"><span class="bold"><strong>size</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the underlying size of the endpoint in the native type.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.generic__basic_endpoint.h2"></a>
        <span><a name="asio.reference.generic__basic_endpoint.friends"></a></span><a class="link" href="generic__basic_endpoint.html#asio.reference.generic__basic_endpoint.friends">Friends</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/operator_not__eq_.html" title="generic::basic_endpoint::operator!="><span class="bold"><strong>operator!=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare two endpoints for inequality.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/operator_lt_.html" title="generic::basic_endpoint::operator&lt;"><span class="bold"><strong>operator&lt;</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare endpoints for ordering.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/operator_lt__eq_.html" title="generic::basic_endpoint::operator&lt;="><span class="bold"><strong>operator&lt;=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare endpoints for ordering.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/operator_eq__eq_.html" title="generic::basic_endpoint::operator=="><span class="bold"><strong>operator==</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare two endpoints for equality.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/operator_gt_.html" title="generic::basic_endpoint::operator&gt;"><span class="bold"><strong>operator&gt;</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare endpoints for ordering.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="generic__basic_endpoint/operator_gt__eq_.html" title="generic::basic_endpoint::operator&gt;="><span class="bold"><strong>operator&gt;=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Compare endpoints for ordering.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<p>
        The <a class="link" href="generic__basic_endpoint.html" title="generic::basic_endpoint"><code class="computeroutput">generic::basic_endpoint</code></a>
        class template describes an endpoint that may be associated with any socket
        type.
      </p>
<h5>
<a name="asio.reference.generic__basic_endpoint.h3"></a>
        <span><a name="asio.reference.generic__basic_endpoint.remarks"></a></span><a class="link" href="generic__basic_endpoint.html#asio.reference.generic__basic_endpoint.remarks">Remarks</a>
      </h5>
<p>
        The socket types sockaddr type must be able to fit into a <code class="computeroutput">sockaddr_storage</code>
        structure.
      </p>
<h5>
<a name="asio.reference.generic__basic_endpoint.h4"></a>
        <span><a name="asio.reference.generic__basic_endpoint.thread_safety"></a></span><a class="link" href="generic__basic_endpoint.html#asio.reference.generic__basic_endpoint.thread_safety">Thread Safety</a>
      </h5>
<p>
        <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
      </p>
<p>
        <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
      </p>
<h5>
<a name="asio.reference.generic__basic_endpoint.h5"></a>
        <span><a name="asio.reference.generic__basic_endpoint.requirements"></a></span><a class="link" href="generic__basic_endpoint.html#asio.reference.generic__basic_endpoint.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/generic/basic_endpoint.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2018 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="experimental__this_coro__token_t.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="generic__basic_endpoint/basic_endpoint.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
